KsLogChannel Class

Represents the log channel settings.

Inheritance Hierarchy

System.Object
IntervalZero.KINGSTAR.Base.KsLogChannel

Assembly: IntervalZero.KINGSTAR.Base (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

C#VB

public class KsLogChannel

Public Class KsLogChannel

The KsLogChannel class exposes the following members.

Constructors

	Name	Description
	KsLogChannel	Initializes a new instance of the KsLogChannel class.

Fields

	Name	Description
	DataType	Selects the data type if the log source is an input or output of a module and UserVariable.
	Index	The index of an axis, input or output. NOTE: For UserVariable, this is only supported for KINGSTAR 4.3 and earlier versions.
	Offset	Sets the offset if the log source is: An axis, and the log variable is `logDigitalInputs` or `logDigitalOutputs`. The unit of offset is bit. An input or output of a module. The unit of the offset depends on the data types. - logBool. The unit of offset is bit. - Other data types except logBool. The unit of offset is byte.
	Source	Records the data from a single axis, input, output and UserVariable.

Properties

	Name	Description
	SourceHandle	This can be used for UserVariable. You can pass the UserVariable to KsLogChannel.SourceHandle. For example: logChannel.SourceHandle = Temperature.Id NOTE: This is only supported for KINGSTAR 4.4 and later versions.
	Variable	Selects the variable you want to record if the log source is an axis. When Source is logUser, Variable is not used.

Name

Description

SourceHandle

This can be used for UserVariable. You can pass the UserVariable to KsLogChannel.SourceHandle.

For example:

logChannel.SourceHandle = Temperature.Id

NOTE: This is only supported for KINGSTAR 4.4 and later versions.

Selects the variable you want to record if the log source is an axis. When Source is logUser, Variable is not used.